Skip to content

api,server: allow cleaning up vm extraconfig #11974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

api,server: allow cleaning up vm extraconfig #11974

wants to merge 3 commits into from
+200 −13

Conversation

@shwstppr
Copy link
Contributor

@shwstppr shwstppr commented Nov 4, 2025 •
edited
Loading

Description

Fixes #9878

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

(local) 🐱 > update virtualmachine -h
updateVirtualMachine: Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.
Required params: id, 
API Params               Type     Description
==========               ====     ===========
cleanupdetails           boolean  optional boolean field, which indicates i
                                  f details should be cleaned up or not (i
                                  f set to true, details removed for this 
                                  resource, details field ignored; if fals
                                  e or not set, no action)
cleanupextraconfig       boolean  Optional boolean field, which indicates i
                                  f extraconfig for the instance should be
                                   cleaned up or not (If set to true, extr
                                  aconfig removed for this instance, extra
                                  config field ignored; if false or not se
                                  t, no action)
customid                 string   an optional field, in case you want to se
                                  t a custom id to the resource. Allowed t
                                  o Root Admins only
...


(localcloud) 🐱 > list virtualmachines id=d6c566f9-bec2-4daf-b1fb-2da25683229e  filter=id,name,details
{
  "count": 1,
  "virtualmachine": [
    {
      "details": {
        "cpuOvercommitRatio": "2.0",
        "extraconfig-1": "alpha=123\nbeta=456"
      },
      "id": "d6c566f9-bec2-4daf-b1fb-2da25683229e",
      "name": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e"
    }
  ]
}
(localcloud) 🐱 > update virtualmachine id=d6c566f9-bec2-4daf-b1fb-2da25683229e cleanupextraconfig=true
{
  "virtualmachine": {
    "account": "admin",
    "affinitygroup": [],
    "arch": "x86_64",
    "cpunumber": 1,
    "cpuspeed": 500,
    "cpuused": "14.36%",
    "created": "2025-12-01T06:26:23+0000",
    "deleteprotection": false,
    "details": {
      "cpuOvercommitRatio": "2.0"
    },
    "diskioread": 0,
    "diskiowrite": 4,
    "diskkbsread": 0,
    "diskkbswrite": 24,
    "displayname": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e",
    "displayvm": true,
    "domain": "ROOT",
    "domainid": "82f87e9e-ce76-11f0-8a20-1e00060003cb",
    "domainpath": "ROOT",
    "guestosid": "83199135-ce76-11f0-8a20-1e00060003cb",
    "haenable": false,
    "hasannotations": false,
    "hostcontrolstate": "Enabled",
    "hostid": "5249cdbd-9ca9-4c00-a734-0537d89d0dbc",
    "hostname": "pr11974-t14893-kvm-ol8-kvm1",
    "hypervisor": "KVM",
    "id": "d6c566f9-bec2-4daf-b1fb-2da25683229e",
    "instancename": "i-2-3-VM",
    "isdynamicallyscalable": false,
    "lastupdated": "2025-12-01T06:26:37+0000",
    "memory": 512,
    "memoryintfreekbs": -1,
    "memorykbs": 524288,
    "memorytargetkbs": 524288,
    "name": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e",
    "networkkbsread": 0,
    "networkkbswrite": 0,
    "nic": [
      {
        "broadcasturi": "vlan://1262",
        "deviceid": "0",
        "extradhcpoption": [],
        "id": "4c576998-3258-4f52-9df1-766315d8f14e",
        "isdefault": true,
        "isolationuri": "vlan://1262",
        "macaddress": "02:01:00:cc:00:01",
        "networkid": "882de96d-a74f-4131-814d-9d8e09119125",
        "networkname": "test",
        "secondaryip": [],
        "traffictype": "Guest",
        "type": "L2"
      }
    ],
    "osdisplayname": "CentOS 5.5 (64-bit)",
    "ostypeid": "83199135-ce76-11f0-8a20-1e00060003cb",
    "passwordenabled": false,
    "pooltype": "NetworkFilesystem",
    "receivedbytes": 0,
    "rootdeviceid": 0,
    "rootdevicetype": "ROOT",
    "securitygroup": [],
    "sentbytes": 0,
    "serviceofferingid": "c049fc6b-1ff2-4ce5-a881-aaa26b9625e1",
    "serviceofferingname": "Small Instance",
    "state": "Running",
    "tags": [],
    "templatedisplaytext": "CentOS 5.5(64-bit) no GUI (KVM)",
    "templateformat": "QCOW2",
    "templateid": "82fe7d45-ce76-11f0-8a20-1e00060003cb",
    "templatename": "CentOS 5.5(64-bit) no GUI (KVM)",
    "templatetype": "BUILTIN",
    "userid": "bea6206e-ce76-11f0-8a20-1e00060003cb",
    "username": "admin",
    "zoneid": "15d72fa5-8b47-4d90-b1c2-9e2c0d0b78e5",
    "zonename": "pr11974-t14893-kvm-ol8"
  }
}
(localcloud) 🐱 > list virtualmachines id=d6c566f9-bec2-4daf-b1fb-2da25683229e  filter=id,name,details
{
  "count": 1,
  "virtualmachine": [
    {
      "details": {
        "cpuOvercommitRatio": "2.0"
      },
      "id": "d6c566f9-bec2-4daf-b1fb-2da25683229e",
      "name": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e"
    }
  ]
}
clear-vm-extraconfig.mp4

How did you try to break this feature and the system with this change?

@codecov
Copy link

codecov bot commented Nov 4, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 89.65517% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.57%. Comparing base (db61470) to head (3793688).
⚠️ Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
...he/cloudstack/api/command/user/vm/UpdateVMCmd.java 0.00% 3 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff            @@
##               main   #11974   +/-   ##
=========================================
  Coverage     17.56%   17.57%           
- Complexity    15548    15557    +9     
=========================================
  Files          5913     5913           
  Lines        529440   529465   +25     
  Branches      64670    64671    +1     
=========================================
+ Hits          93019    93062   +43     
+ Misses       425963   425943   -20     
- Partials      10458    10460    +2
Flag Coverage Δ
uitests 3.58% <ø> (-0.01%) ⬇️
unittests 18.64% <89.65%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@shwstppr
Copy link
Contributor Author

shwstppr commented Nov 13, 2025

@blueorangutan package

@blueorangutan
Copy link

blueorangutan commented Nov 13, 2025

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@blueorangutan
Copy link

blueorangutan commented Nov 13, 2025

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15738

@shwstppr shwstppr marked this pull request as ready for review December 1, 2025 06:46
@shwstppr
Copy link
Contributor Author

shwstppr commented Dec 1, 2025

@blueorangutan package

@blueorangutan
Copy link

blueorangutan commented Dec 1, 2025

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@shwstppr shwstppr requested a review from abh1sar December 1, 2025 07:29
DaanHoogland
DaanHoogland approved these changes Dec 1, 2025
View reviewed changes
Copy link
Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

engine/schema/src/main/java/com/cloud/vm/dao/VMInstanceDetailsDaoImpl.java
Comment on lines +43 to +48
sb.and("vmId", sb.entity().getResourceId(), SearchCriteria.Op.EQ);
sb.and("prefix", sb.entity().getName(), SearchCriteria.Op.LIKE);
sb.done();
SearchCriteria<VMInstanceDetailVO> sc = sb.create();
sc.setParameters("vmId", vmId);
sc.setParameters("prefix", prefix + "%");
Copy link
Contributor

@DaanHoogland DaanHoogland Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bit gives me to think that we might want to include these in a DbConstants, similar to the ApiConstants. No critisism on this PR as I know this is the general practice atm.

@blueorangutan
Copy link

blueorangutan commented Dec 1, 2025

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15874

abh1sar
abh1sar approved these changes Dec 1, 2025
View reviewed changes
Copy link
Collaborator

@abh1sar abh1sar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A minor comment. Otherwise the code LGTM.

server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java
Comment on lines +473 to +476
private void overrideDefaultConfigValue(final ConfigKey configKey, final Object o) {
try {
final String name = "_defaultValue";
Field f = ConfigKey.class.getDeclaredField(name);
Copy link
Collaborator

@abh1sar abh1sar Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we revert this in teardown?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@DaanHoogland DaanHoogland DaanHoogland approved these changes

@nvazquez nvazquez Awaiting requested review from nvazquez

@weizhouapache weizhouapache Awaiting requested review from weizhouapache

+1 more reviewer

@abh1sar abh1sar abh1sar approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

component:api component:UI status:needs-testing

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

feature: cleanup VM extraconfig in updateVirtualMachine API

4 participants

@shwstppr @blueorangutan @DaanHoogland @abh1sar